-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ENH: Finalize migration of reporting interfaces #71
Conversation
b91ff7c
to
7ea0b3a
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #71 +/- ##
==========================================
+ Coverage 60.34% 64.70% +4.35%
==========================================
Files 20 23 +3
Lines 2242 2618 +376
Branches 399 422 +23
==========================================
+ Hits 1353 1694 +341
- Misses 795 812 +17
- Partials 94 112 +18 ☔ View full report in Codecov by Sentry. |
7ea0b3a
to
fb79a20
Compare
fb79a20
to
6846c70
Compare
6846c70
to
4182979
Compare
This sidetracks #71 for interfaces with little discussion about whether they can be consider core enough to be maintained within NiReports. In addition, moves the SimpleBeforeAfter interface into the set of basic interfaces, as it is very often used.
This sidetracks #71 for interfaces with little discussion about whether they can be consider core enough to be maintained within NiReports. In addition, moves the SimpleBeforeAfter interface into the set of basic interfaces, as it is very often used.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should get this in and cut a new release, so we can:
- migrate end user tools away from niworkflows reporting
- deprecate niworkflows reporting
Co-authored-by: Mathias Goncalves <[email protected]>
8d197b5
to
70bfd85
Compare
24.1.0 (December 18, 2024) New feature release in the 24.1.x series. This release includes a migration of most if not all reporting interfaces from NiWorkflows. This release also supports Python 3.13 and Numpy 2. * ENH: Finalize migration of reporting interfaces (#71) * ENH: Allow figures in session folder (#138) * RF: Replace nireports.data.Loader with acres.Loader (#142) * STY: Apply new ruff rules (#139) * MAINT: Add tox.ini, test minimum dependencies (#141)
This PR brings generalistic "reportlet capable" interfaces from niworkflows. It doesn't port those interfaces modified by niworkflows (e.g., the report-generating version of the normalization interface).
I'm a bit on the fence about this. Perhaps a cleaner way is to have a
nipreps.interfaces
namespace where packages can "contribute" their custom interfaces, where a set of default interfaces is available.This would be consistent with @mgxd's idea of
nipreps.synthstrip
and so forth.Also, splitting workflows and interfaces from niworkflows would probably be the best approach for clarity, and have niworkflows populate
nipreps.workflows
and nipreps-interfaces (or similar) populatenipreps.interfaces
.What do you think?
Resolves: #54.